<?xml version="1.0" encoding="ascii"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
          "DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <title>simplejson.decoder.JSONDecoder</title>
  <link rel="stylesheet" href="epydoc.css" type="text/css" />
  <script type="text/javascript" src="epydoc.js"></script>
</head>

<body bgcolor="white" text="black" link="blue" vlink="#204080"
      alink="#204080">
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
  <tr valign="top">
    <td width="100%">
      <span class="breadcrumbs">
        <a href="simplejson-module.html">Package&nbsp;simplejson</a> ::
        <a href="simplejson.decoder-module.html" onclick="show_private();">Module&nbsp;decoder</a> ::
        Class&nbsp;JSONDecoder
      </span>
    </td>
    <td>
      <table cellpadding="0" cellspacing="0">
        <!-- hide/show private -->
        <tr><td align="right"><span class="options">[<a href="javascript:void(0);" class="privatelink"
    onclick="toggle_private();">hide&nbsp;private</a>]</span></td></tr>
        <tr><td align="right"><span class="options"
            >[<a href="frames.html" target="_top">frames</a
            >]&nbsp;|&nbsp;<a href="simplejson.decoder.JSONDecoder-class.html"
            target="_top">no&nbsp;frames</a>]</span></td></tr>
      </table>
    </td>
  </tr>
</table>
<!-- ==================== CLASS DESCRIPTION ==================== -->
<h1 class="epydoc">Class JSONDecoder</h1><p class="nomargin-top"><span class="codelink"><a href="simplejson.decoder-pysrc.html#JSONDecoder">source&nbsp;code</a></span></p>
<pre class="base-tree">
object --+
         |
        <strong class="uidshort">JSONDecoder</strong>
</pre>

<hr />
<p>Simple JSON &lt;http://json.org&gt; decoder</p>
  <p>Performs the following translations in decoding by default:</p>
  <p>+---------------+-------------------+ | JSON          | Python
  | +===============+===================+ | object        | dict
  | +---------------+-------------------+ | array         | list
  | +---------------+-------------------+ | string        | unicode
  | +---------------+-------------------+ | number (int)  | int, long
  | +---------------+-------------------+ | number (real) | float
  | +---------------+-------------------+ | true          | True
  | +---------------+-------------------+ | false         | False
  | +---------------+-------------------+ | null          | None
  | +---------------+-------------------+</p>
  <p>It also understands ``NaN``, ``Infinity``, and ``-Infinity`` as their 
  corresponding ``float`` values, which is outside the JSON spec.</p>

<!-- ==================== INSTANCE METHODS ==================== -->
<a name="section-InstanceMethods"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Instance Methods</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-InstanceMethods"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simplejson.decoder.JSONDecoder-class.html#__init__" class="summary-sig-name">__init__</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">encoding</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">object_hook</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">parse_float</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">parse_int</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">parse_constant</span>=<span class="summary-sig-default">None</span>,
        <span class="summary-sig-arg">strict</span>=<span class="summary-sig-default">True</span>)</span><br />
      ``encoding`` determines the encoding used to interpret any ``str`` 
      objects decoded by this instance (utf-8 by default).</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simplejson.decoder-pysrc.html#JSONDecoder.__init__">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a name="decode"></a><span class="summary-sig-name">decode</span>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">s</span>,
        <span class="summary-sig-arg">_w</span>=<span class="summary-sig-default">&lt;built-in method match of _sre.SRE_Pattern object at 0x02ADC848&gt;</span>)</span><br />
      Return the Python representation of ``s`` (a ``str`` or ``unicode`` 
      instance containing a JSON document)</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simplejson.decoder-pysrc.html#JSONDecoder.decode">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
<tr>
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
      <table width="100%" cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td><span class="summary-sig"><a href="simplejson.decoder.JSONDecoder-class.html#raw_decode" class="summary-sig-name">raw_decode</a>(<span class="summary-sig-arg">self</span>,
        <span class="summary-sig-arg">s</span>,
        <span class="summary-sig-arg">**kw</span>)</span><br />
      Decode a JSON document from ``s`` (a ``str`` or ``unicode`` beginning
      with a JSON document) and return a 2-tuple of the Python 
      representation and the index in ``s`` where the document ended.</td>
          <td align="right" valign="top">
            <span class="codelink"><a href="simplejson.decoder-pysrc.html#JSONDecoder.raw_decode">source&nbsp;code</a></span>
            
          </td>
        </tr>
      </table>
      
    </td>
  </tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__delattr__</code>,
      <code>__getattribute__</code>,
      <code>__hash__</code>,
      <code>__new__</code>,
      <code>__reduce__</code>,
      <code>__reduce_ex__</code>,
      <code>__repr__</code>,
      <code>__setattr__</code>,
      <code>__str__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== CLASS VARIABLES ==================== -->
<a name="section-ClassVariables"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Class Variables</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-ClassVariables"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="_scanner"></a><span class="summary-name">_scanner</span> = <code title="Scanner(ANYTHING)">Scanner(ANYTHING)</code>
    </td>
  </tr>
<tr class="private">
    <td width="15%" align="right" valign="top" class="summary">
      <span class="summary-type">&nbsp;</span>
    </td><td class="summary">
        <a name="__all__"></a><span class="summary-name">__all__</span> = <code title="['__init__', 'decode', 'raw_decode']"><code class="variable-group">[</code><code class="variable-quote">'</code><code class="variable-string">__init__</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">decode</code><code class="variable-quote">'</code><code class="variable-op">, </code><code class="variable-quote">'</code><code class="variable-string">raw_decode</code><code class="variable-quote">'</code><code class="variable-group">]</code></code>
    </td>
  </tr>
</table>
<!-- ==================== PROPERTIES ==================== -->
<a name="section-Properties"></a>
<table class="summary" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Properties</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-Properties"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
  <tr>
    <td colspan="2" class="summary">
    <p class="indent-wrapped-lines"><b>Inherited from <code>object</code></b>:
      <code>__class__</code>
      </p>
    </td>
  </tr>
</table>
<!-- ==================== METHOD DETAILS ==================== -->
<a name="section-MethodDetails"></a>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="table-header">
  <td colspan="2" class="table-header">
    <table border="0" cellpadding="0" cellspacing="0" width="100%">
      <tr valign="top">
        <td align="left"><span class="table-header">Method Details</span></td>
        <td align="right" valign="top"
         ><span class="options">[<a href="#section-MethodDetails"
         class="privatelink" onclick="toggle_private();"
         >hide private</a>]</span></td>
      </tr>
    </table>
  </td>
</tr>
</table>
<a name="__init__"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">__init__</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">encoding</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">object_hook</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">parse_float</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">parse_int</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">parse_constant</span>=<span class="sig-default">None</span>,
        <span class="sig-arg">strict</span>=<span class="sig-default">True</span>)</span>
    <br /><em class="fname">(Constructor)</em>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="simplejson.decoder-pysrc.html#JSONDecoder.__init__">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>``encoding`` determines the encoding used to interpret any ``str`` 
  objects decoded by this instance (utf-8 by default).  It has no effect 
  when decoding ``unicode`` objects.</p>
  <p>Note that currently only encodings that are a superset of ASCII work, 
  strings of other encodings should be passed in as ``unicode``.</p>
  <p>``object_hook``, if specified, will be called with the result of every
  JSON object decoded and its return value will be used in place of the 
  given ``dict``.  This can be used to provide custom deserializations 
  (e.g. to support JSON-RPC class hinting).</p>
  <p>``parse_float``, if specified, will be called with the string of every
  JSON float to be decoded. By default this is equivalent to 
  float(num_str). This can be used to use another datatype or parser for 
  JSON floats (e.g. decimal.Decimal).</p>
  <p>``parse_int``, if specified, will be called with the string of every 
  JSON int to be decoded. By default this is equivalent to int(num_str). 
  This can be used to use another datatype or parser for JSON integers 
  (e.g. float).</p>
  <p>``parse_constant``, if specified, will be called with one of the 
  following strings: -Infinity, Infinity, NaN, null, true, false. This can 
  be used to raise an exception if invalid JSON numbers are 
  encountered.</p>
  <dl class="fields">
    <dt>Overrides:
        object.__init__
    </dt>
  </dl>
</td></tr></table>
</div>
<a name="raw_decode"></a>
<div>
<table class="details" border="1" cellpadding="3"
       cellspacing="0" width="100%" bgcolor="white">
<tr><td>
  <table width="100%" cellpadding="0" cellspacing="0" border="0">
  <tr valign="top"><td>
  <h3 class="epydoc"><span class="sig"><span class="sig-name">raw_decode</span>(<span class="sig-arg">self</span>,
        <span class="sig-arg">s</span>,
        <span class="sig-arg">**kw</span>)</span>
  </h3>
  </td><td align="right" valign="top"
    ><span class="codelink"><a href="simplejson.decoder-pysrc.html#JSONDecoder.raw_decode">source&nbsp;code</a></span>&nbsp;
    </td>
  </tr></table>
  
  <p>Decode a JSON document from ``s`` (a ``str`` or ``unicode`` beginning 
  with a JSON document) and return a 2-tuple of the Python representation 
  and the index in ``s`` where the document ended.</p>
  <p>This can be used to decode a JSON document from a string that may have
  extraneous data at the end.</p>
  <dl class="fields">
  </dl>
</td></tr></table>
</div>
<br />
<!-- ==================== NAVIGATION BAR ==================== -->
<table class="navbar" border="0" width="100%" cellpadding="0"
       bgcolor="#a0c0ff" cellspacing="0">
  <tr valign="middle">

  <!-- Tree link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="module-tree.html">Trees</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Index link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="identifier-index.html">Indices</a>&nbsp;&nbsp;&nbsp;</th>

  <!-- Help link -->
      <th>&nbsp;&nbsp;&nbsp;<a
        href="help.html">Help</a>&nbsp;&nbsp;&nbsp;</th>

      <th class="navbar" width="100%"></th>
  </tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
  <tr>
    <td align="left" class="footer">
    Generated by Epydoc 3.0.1 on Thu Jan 29 04:00:46 2009
    </td>
    <td align="right" class="footer">
      <a target="mainFrame" href="http://epydoc.sourceforge.net"
        >http://epydoc.sourceforge.net</a>
    </td>
  </tr>
</table>

<script type="text/javascript">
  <!--
  // Private objects are initially displayed (because if
  // javascript is turned off then we want them to be
  // visible); but by default, we want to hide them.  So hide
  // them unless we have a cookie that says to show them.
  checkCookie();
  // -->
</script>
</body>
</html>
